Fzzy Config/me.fzzyhmstrs.fzzy_config.annotations

Package-level declarations

Types

enum Action : Enum<Action>

Defines an action the user or server owner needs to take if a setting is changed. Actions are sorted in priority by their ordinal (RESTART is the highest priority action and so on).

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class AdminAccess(val perms: Array<String>, val fallback: Int = -1)

Paired with WithCustomPerms. Defines the permissions needed for "admin" access to the config.

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class BlockArray(val itemsPerLine: Int = 1)

Java-field-friendly version of TomlBlockArray

ClientModifiable

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class ClientModifiable

Marks the annotated config entry as modifiable by any player, not just Ops.

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class Comment(val value: String)

Java field-friendly version of TomlComment

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class ConvertFrom(val fileName: String, val folder: String = "", val subfolder: String = "")

Provides the path to an old config file used before updating to FzzyConfig. FzzyConfig will attempt to read the file and scrape as much data as possible from it into the new config class and format (TOML).

IgnoreVisibility

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class IgnoreVisibility

A config marked with this annotation will attempt to ignore field visibility when de/serialization

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class Inline

Java field-friendly version of TomlInline

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class Integer(val base: TomlInteger.Base = TomlInteger.Base.Dec, val group: Int = 0)

Java field-friendly version of TomlInteger

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class LiteralString

Java field-friendly version of TomlLiteralString

MultilineString

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY])

annotation class MultilineString

Java field-friendly version of TomlMultilimeString

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD])

annotation class NonSync

Excludes an element of a Config from synchronization.

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class RequiresAction(val action: Action)

Properties fields marked with RequiresAction will prompt the user that changes will require a certain action as defined by the Action enum selected

RequiresRestart

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class ~~RequiresRestart~~

Properties or fields marked with RequiresRestart will prompt the user that changes will require a restart of the server/client

TomlHeaderComment

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class TomlHeaderComment(val text: String)

Adds a Comment to the Version key of a config file.

@Target(allowedTargets = [AnnotationTarget.FIELD, AnnotationTarget.PROPERTY, AnnotationTarget.CLASS])

annotation class Translation(val prefix: String, val negate: Boolean = false)

Defines a custom translation key prefix for the annotated members, or all members of the annotated class.

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Version(val version: Int)

Defines the version of the config file.

WithCustomPerms

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class WithCustomPerms(val perms: Array<String>, val fallback: Int = -1)

Paired with AdminAccess Applies custom permission restrictions to a config setting. Overridden by ClientModifiable

@Target(allowedTargets = [AnnotationTarget.PROPERTY, AnnotationTarget.FIELD, AnnotationTarget.CLASS])

annotation class WithPerms(val opLevel: Int = 3)

Applies permission restrictions to a config setting.